feat: basic get/post endpoint for v2 xblocks. TNL-10873 #32600
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kenclary
force-pushed
the
kenclary/TNL-10873
branch
5 times, most recently
from
2ea4170 to
e00cda1
Compare
kenclary
force-pushed
the
kenclary/TNL-10873
branch
25 times, most recently
from
5b4b53f to
350a379
Compare
kenclary
force-pushed
the
kenclary/TNL-10873
branch
16 times, most recently
from
47b1c70 to
3e03662
Compare
kenclary
changed the title
bradenmacdonald
approved these changes
Jul 19, 2023
| } | ||
| }, format='json') | ||
| block_saved = xblock_api.load_block(block_key, self.staff_user) | ||
| assert block_saved.data == '\n<p>test</p>\n' |
There was a problem hiding this comment.
Will it be an issue for the editors if some newlines go inserted here? This test set the data to '<p>test</p>' but we get the data back as '\n<p>test</p>\n'. I'm assuming that's fine but just want to confirm.
There was a problem hiding this comment.
no, in fact I don't think editors can have content without the newlines; it's just an artifact of what I wrote in the test.
| @@ -133,7 +133,9 @@ def save_block(self, block): | |||
| if not learning_context.can_edit_block(self.user, block.scope_ids.usage_id): | |||
| log.warning("User %s does not have permission to edit %s", self.user.username, block.scope_ids.usage_id) | |||
| raise RuntimeError("You do not have permission to edit this XBlock") | |||
| olx_str, static_files = serialize_xblock(block) | |||
| serialized = serialize_modulestore_block_for_blockstore(block) | |||
There was a problem hiding this comment.
I guess we should rename this function to just serialize_block_for_blockstore since we're already passing in a blockstore block here.
There was a problem hiding this comment.
it is called in a bunch of other places.
kenclary
force-pushed
the
kenclary/TNL-10873
branch
from
3e03662 to
255d58b
Compare
kenclary
force-pushed
the
kenclary/TNL-10873
branch
2 times, most recently
from
7d58c41 to
99f7cdc
Compare
connorhaugh
approved these changes
Jul 20, 2023
Comment on lines
+179
to
+185
| View to get/edit the field values of an XBlock as JSON (in the v2 runtime) | ||
|
|
||
| This class mimics the functionality of xblock_handler in block.py (for v1 xblocks), but for v2 xblocks. | ||
| However, it only implements the exact subset of functionality needed to support the v2 editors (from | ||
| the frontend-lib-content-components project). As such, it only supports GET and POST, and only the | ||
| POSTing of data/metadata fields. | ||
| """ |
There was a problem hiding this comment.
Suggested change
| View to get/edit the field values of an XBlock as JSON (in the v2 runtime) | |
| This class mimics the functionality of xblock_handler in block.py (for v1 xblocks), but for v2 xblocks. | |
| However, it only implements the exact subset of functionality needed to support the v2 editors (from | |
| the frontend-lib-content-components project). As such, it only supports GET and POST, and only the | |
| POSTing of data/metadata fields. | |
| """ | |
| View for the field values of an XBlock, returned as JSON. | |
| This class mimics the functionality of the v1 xblock_handler in block.py. | |
| However, it only implements the exact subset of functionality needed to support xblock editing, for a single xblock which has no children blocks. As such, it only supports GET and POST. | |
| """ |
kenclary
force-pushed
the
kenclary/TNL-10873
branch
from
99f7cdc to
d6f824d
Compare
|
2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production. |
|
2U Release Notice: This PR has been deployed to the edX production environment. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
feat: basic get/post endpoint for v2 xblocks. TNL-10873